forcecell.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

 
#ifndef FORCECELL_H
#define FORCECELL_H
 
#ifdef __cplusplus
extern "C"{
#endif

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_analog_in.h"
#include "drv_i2c_master.h"




#define FORCECELL_R6_KOHM               2.7
#define FORCECELL_GAIN                  ( ( 100 / FORCECELL_R6_KOHM ) + 1 )
#define FORCECELL_SENSITIVITY_V_V       0.025
#define FORCECELL_FULL_SCALE_N          30

#define FORCECELL_NUM_CONVERSIONS       100

#define FORCECELL_TIMEOUT_MS            2000

#define FORCECELL_ADC_RESOLUTION        0x0FFF
#define FORCECELL_VREF_3V3              3.3
#define FORCECELL_VREF_5V               5.0
#define FORCECELL_VREF                  FORCECELL_VREF_3V3

#define FORCECELL_SET_DEV_ADDR          0x4D
 // forcecell_set



#define FORCECELL_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.an  = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );
 // forcecell_map // forcecell

typedef enum
{
    FORCECELL_DRV_SEL_ADC,              
    FORCECELL_DRV_SEL_I2C               
 
} forcecell_drv_t;

typedef struct
{
    analog_in_t  adc;                   
    i2c_master_t i2c;                   
 
    uint8_t      slave_address;         
    float        vref;                  
    forcecell_drv_t drv_sel;            
    float        zero_force_offset;     
 
} forcecell_t;

typedef struct
{
    pin_name_t an;                      
    pin_name_t scl;                     
    pin_name_t sda;                     
 
    analog_in_resolution_t resolution;  
    float                  vref;        
    
    uint32_t               i2c_speed;   
    uint8_t                i2c_address; 
    
    forcecell_drv_t drv_sel;            
 
} forcecell_cfg_t;

typedef enum
{
    FORCECELL_OK = 0,
    FORCECELL_ERROR = -1
 
} forcecell_return_value_t;


void forcecell_cfg_setup ( forcecell_cfg_t *cfg );

void forcecell_drv_interface_sel ( forcecell_cfg_t *cfg, forcecell_drv_t drv_sel );

err_t forcecell_init ( forcecell_t *ctx, forcecell_cfg_t *cfg );

err_t forcecell_read_raw_adc ( forcecell_t *ctx, uint16_t *raw_adc );

err_t forcecell_read_voltage ( forcecell_t *ctx, float *voltage );

err_t forcecell_read_voltage_avg ( forcecell_t *ctx, uint16_t num_conv, float *voltage_avg );

err_t forcecell_set_vref ( forcecell_t *ctx, float vref );

err_t forcecell_calib_offset ( forcecell_t *ctx );

err_t forcecell_read_force ( forcecell_t *ctx, float *force );
 
#ifdef __cplusplus
}
#endif
#endif // FORCECELL_H
 // forcecell
 
// ------------------------------------------------------------------------ END